feat(user-management): update docs#37
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances API documentation and Swagger/OpenAPI configuration while updating project docs and licensing.
- Adds a new
DISABLE_SSLenvironment variable for local containerized API setups. - Configures Swagger/OpenAPI with filters to remove internal schemas and defines OAuth2 security flows.
- Revises the YAML spec, expands the README with architecture and usage details, and adds license/NOTICE files.
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| user-management/src/Stickerlandia.UserManagement.Aspire/AppBuilderExtensions.cs | Adds DISABLE_SSL env var for local containerized API |
| user-management/src/Stickerlandia.UserManagement.Api/Program.cs | Excludes the login endpoint from description in the async API doc |
| user-management/src/Stickerlandia.UserManagement.Api/Configurations/RemoveSwaggerDefinitionsFilter.cs | Adds a document filter to remove internal claim schemas from Swagger |
| user-management/src/Stickerlandia.UserManagement.Api/Configurations/DocumentationConfig.cs | Configures SwaggerGen with OAuth2 security definitions and document filter |
| user-management/src/Stickerlandia.UserManagement.Api/Configurations/AuthorizeOperationFilter.cs | Adds an operation filter to inject 401/403 responses and security requirements |
| user-management/docs/api.yaml | Quotes path keys, removes inline login/register specs, and adds OAuth2 securitySchemes |
| user-management/README.md | Overhauls README with architecture, domain structure, endpoints, and usage steps |
| user-management/NOTICE | Introduces NOTICE file for attribution |
| user-management/LICENSE | Adds Apache 2.0 license text |
Comments suppressed due to low confidence (2)
user-management/docs/api.yaml:190
- Using 'file:///' URLs for the OAuth2 authorizationCode flow is likely incorrect; consider using HTTP(S) URLs consistent with other flows.
authorizationUrl: file:///authorize
user-management/README.md:11
- This is a C#/.NET project; referencing
.javafiles here appears incorrect. Update file names/extensions to match actual C# implementation.
- `StickerAwardResource.java` - HTTP API for user assignments
…tions/RemoveSwaggerDefinitionsFilter.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…tions/AuthorizeOperationFilter.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…dia into chore/update-user-docs
scottgerring
left a comment
scottgerring
left a comment
Member
There was a problem hiding this comment.
Some Qs and a couple suggestions!
|
|
||
| namespace Stickerlandia.UserManagement.Api.Configurations; | ||
|
|
||
| internal class AuthorizeOperationFilter |
Member
There was a problem hiding this comment.
This feels like something that could benefit from some ```classdocs !
scottgerring
approved these changes
Jun 18, 2025
jeastham1993
added a commit
that referenced
this pull request
Jun 19, 2025
* feat: correct sticker-award to handle errors according to API spec * feat: add AWS implementation and IaC * Update user-management/infra/aws/lib/network.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * feat: update connection string * chore: add labels to docker image * chore: remove ASPNET Lambda hosting * chore: add todos for future shared infra * feat: enable static analysis (#44) * feat: implement fixes from static analysis * feat: add static analysis configuration * feat: add static analysis configuration * fix: remove duplicate .sln file * Update user-management/src/Stickerlandia.UserManagement.Api/Configurations/RemoveSwaggerDefinitionsFilter.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Merge pull request #45 from DataDog/feat/add-datadog-to-docker feat: add Datadog tracer to Dockerfiles * feat(user-management): update docs (#37) * chore: update OpenAPI docs * chore: update README * chore: add license and notice files * chore: add dockerignore file * Update user-management/src/Stickerlandia.UserManagement.Api/Configurations/RemoveSwaggerDefinitionsFilter.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update user-management/src/Stickerlandia.UserManagement.Api/Configurations/AuthorizeOperationFilter.cs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update user-management/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * chore: expand local dev and code structure docs * chore: add cloud provider specific SLN files * fix: specify .sln in dotnet restore * chore: docs updates --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * feat: add AWS implementation and IaC * feat: update connection string * Update user-management/infra/aws/lib/network.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * chore: add labels to docker image * chore: remove ASPNET Lambda hosting * chore: add todos for future shared infra * chore: fix static analysis for AWS impls * feat: add arch diagram and README for AWS infra --------- Co-authored-by: Scott Gerring <scott@scottgerring.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Scott Gerring <scottgerring@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.